feat: collect har file on test fail #22526

dkwon17 · 2023-09-18T20:31:25Z

What does this PR do?

Uses https://www.npmjs.com/package/chrome-har to convert an array of network events into a har file. The har file is saved in the reports folder on test failures.

Screenshot/screencast of this PR

Viewing har file from tests/e2e/report/ within Chrome Developer Tools:

Screen.Recording.2023-09-25.at.11.47.17.AM.mov

What issues does this PR fix or reference?

#22492

How to test this PR?

On an OpenShift cluster, install Eclipse Che
Checkout this PR, cd to tests/e2e
Run the following to set the necessary environment variables:

export TS_SELENIUM_BASE_URL=<CHE_URL>
export TS_SELENIUM_OCP_USERNAME=<USERNAME>
export TS_SELENIUM_OCP_PASSWORD=<PASSWORD>
export TS_SELENIUM_VALUE_OPENSHIFT_OAUTH=true

Run npm ci
Apply the following patch to guarantee that one of the smoke tests fail:

git apply <<EOF
diff --git a/tests/e2e/specs/SmokeTest.spec.ts b/tests/e2e/specs/SmokeTest.spec.ts
index 4a5f08bf76..709371a396 100644
--- a/tests/e2e/specs/SmokeTest.spec.ts
+++ b/tests/e2e/specs/SmokeTest.spec.ts
@@ -46,6 +46,7 @@ suite('The SmokeTest userstory', function (): void {
 		test('Check a project folder has been created', async function (): Promise<void> {
 			const projectName: string = FACTORY_TEST_CONSTANTS.TS_SELENIUM_PROJECT_NAME || StringUtil.getProjectNameFromGitUrl(factoryUrl);
 			projectSection = (await new SideBarView().getContent().getSections())[0]; // get the (WORKSPACE) section from the sidebar - contains project content
+			expect(false).to.be.true;
 			expect(await projectSection.findItem(projectName)).not.eqls(undefined);
 		});
 		test('Check the project files was imported', async function (): Promise<void> {
EOF

Run the smoke tests

export USERSTORY=SmokeTest && npm run test

The test should fail and a .har file should be available in tests/e2e/report/<test-name>/
On Google Chrome / Firefox open Developer Tools and import the .har file under the network tab. The import should be successful, and you should see the list of network requests just like the demo above.

PR Checklist

As the author of this Pull Request I made sure that:

Reviewers

Reviewers, please comment how you tested the PR when approving it.

tests/e2e/utils/CheReporter.ts

nallikaea · 2023-09-19T11:00:10Z

tests/e2e/utils/CheReporter.ts

@@ -24,6 +24,7 @@ import { OAUTH_CONSTANTS } from '../constants/OAUTH_CONSTANTS';
 import { REPORTER_CONSTANTS } from '../constants/REPORTER_CONSTANTS';
 import { PLUGIN_TEST_CONSTANTS } from '../constants/PLUGIN_TEST_CONSTANTS';
 import { inject, injectable } from 'inversify';
+const chromeHar = require('chrome-har')


Could it be performed using 'import' ?

Using import causes an error:

There is no @types package for chrome-har, so I currently use the package like so:
https://github.com/eclipse/che/blob/88e2b95970fb07fb975dbd304c4124cf744380fa/tests/e2e/utils/CheReporter.ts#L29-L30

WDYT?

I see, in this case I am ok with both solutions. We could create own "types" file but I don`t think it is necessary for just one dependency

Sounds good, I have left it at:

// @ts-ignore: No module declaration file import * as chromeHar from 'chrome-har';

nallikaea · 2023-09-27T09:44:41Z

tests/e2e/driver/ChromeDriver.ts

@@ -21,6 +21,7 @@ export class ChromeDriver implements IDriver {

 	constructor() {
 		const options: Options = this.getDriverOptions();
+		options.setLoggingPrefs({performance: 'ALL'})


looks like prettier script was not run before commit

It should be fixed in my latest commit

dkwon17 · 2023-09-29T18:23:38Z

I have fixed the conflict & rebased

Signed-off-by: David Kwon <[email protected]>

nallikaea · 2023-10-05T10:10:00Z

@dkwon17 somehow you commited changes without linting check

12:04:17.015: [che] git -c credential.helper= -c core.quotepath=false -c log.showSignature=false update-index --cacheinfo 100644,61fa55cab6add1b1cbc939c358501842031ffe63,tests/e2e/specs/dashboard-samples/Documentation.spec.ts --
12:04:17.043: [che] git -c credential.helper= -c core.quotepath=false -c log.showSignature=false commit -F /tmp/git-commit-msg-.txt --amend --signoff --
> @eclipse-che/[email protected] lint
> eslint --fix .
/home/marynadolhalova/AquaProjects/che/tests/e2e/utils/CheReporter.ts
   29:1   error  Do not use "@ts-ignore" because it alters compilation errors  @typescript-eslint/ban-ts-comment
  181:10  error  Expected events to have a type annotation                     @typescript-eslint/typedef
  181:50  error  Missing return type on function                               @typescript-eslint/explicit-function-return-type
  182:10  error  Expected har to have a type annotation                        @typescript-eslint/typedef
✖ 4 problems (4 errors, 0 warnings)
husky - pre-commit hook exited with code 1 (error)

dkwon17 · 2023-10-05T14:32:54Z

I will be more careful next time, thank you for the fix: 0811b7e

che-bot added target/branch Indicates that a PR will be merged into a branch other than master. status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. labels Sep 18, 2023

dkwon17 commented Sep 19, 2023

View reviewed changes

tests/e2e/utils/CheReporter.ts Show resolved Hide resolved

nallikaea reviewed Sep 19, 2023

View reviewed changes

dkwon17 force-pushed the har branch from d54abb7 to 7b01249 Compare September 25, 2023 15:42

dkwon17 marked this pull request as ready for review September 25, 2023 17:41

dkwon17 requested review from musienko-maxim, nickboldt, ScrewTSW and dmytro-ndp as code owners September 25, 2023 17:41

dkwon17 force-pushed the har branch 2 times, most recently from d3ee877 to 88e2b95 Compare September 25, 2023 17:47

che-bot added the kind/task Internal things, technical debt, and to-do tasks to be performed. label Sep 25, 2023

nallikaea reviewed Sep 27, 2023

View reviewed changes

nallikaea approved these changes Sep 29, 2023

View reviewed changes

dkwon17 force-pushed the har branch from a35b41e to 98fdf5f Compare September 29, 2023 18:14

dkwon17 added 2 commits October 2, 2023 10:30

feat: collect har file on test fail

d5c205a

Signed-off-by: David Kwon <[email protected]>

Remove unnecessary files, format files

e05cde0

Signed-off-by: David Kwon <[email protected]>

dkwon17 force-pushed the har branch from 98fdf5f to e05cde0 Compare October 2, 2023 14:41

nallikaea merged commit be6d9b8 into eclipse-che:main Oct 2, 2023
3 checks passed

che-bot removed the status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. label Oct 2, 2023

dkwon17 mentioned this pull request Oct 10, 2023

fix: redact headers, cookies, url params in har file #22595

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: collect har file on test fail #22526

feat: collect har file on test fail #22526

dkwon17 commented Sep 18, 2023 •

edited

Loading

nallikaea Sep 19, 2023

dkwon17 Sep 25, 2023

nallikaea Sep 27, 2023

dkwon17 Sep 27, 2023

nallikaea Sep 27, 2023

dkwon17 Sep 27, 2023

dkwon17 commented Sep 29, 2023

nallikaea commented Oct 5, 2023

dkwon17 commented Oct 5, 2023

feat: collect har file on test fail #22526

feat: collect har file on test fail #22526

Conversation

dkwon17 commented Sep 18, 2023 • edited Loading

What does this PR do?

Screenshot/screencast of this PR

What issues does this PR fix or reference?

How to test this PR?

PR Checklist

Reviewers

nallikaea Sep 19, 2023

Choose a reason for hiding this comment

dkwon17 Sep 25, 2023

Choose a reason for hiding this comment

nallikaea Sep 27, 2023

Choose a reason for hiding this comment

dkwon17 Sep 27, 2023

Choose a reason for hiding this comment

nallikaea Sep 27, 2023

Choose a reason for hiding this comment

dkwon17 Sep 27, 2023

Choose a reason for hiding this comment

dkwon17 commented Sep 29, 2023

nallikaea commented Oct 5, 2023

dkwon17 commented Oct 5, 2023

dkwon17 commented Sep 18, 2023 •

edited

Loading